Obtains a handle to a specific window region.

OSStatus GetWindowRegion (
    WindowRef window, 
    WindowRegionCode inRegionCode, 
     ioWinRgn
);

window

A pointer to the window to be examined.

inRegionCode

A constant representing the window region whose handle you wish to obtain; see “Window Region Constants”.

ioWinRgn

On input, a handle to a region created by your application. On return, the handle is set to the specified window region.

function result

A result code.

DISCUSSION

The GetWindowRegion function produces a handle to a window definition function’s window region in response to a kWindowMsgGetRegion message. The visibility of the window is unimportant for GetWindowRegion to work correctly.

VERSION NOTES

This function is available with Appearance Manager 1.0 and later.

AVAILABILITY

Supported in Carbon. Available in CarbonLib 1.0 and later when CarbonLib 1.0 or later is installed. Exported by CarbonLib 1.0 and later and by CarbonLib 1.0 and later.

© 2000 Apple Computer, Inc. — (Last Updated 4/14/2000)